Skip to main content

Init + Create + Verify

NPM Install

npm install @mentaport/certificates

Checkout our examples to get started.

Overview

At Mentaport, we aim to simplify the process for developers and creators to protect the authenticity of their content. We've broken down the process of watermarking, creating a certificate, and verifying it into three simple steps: Init, Create, and Verify.

How It Works​

  • When a user creates a certificate, it is minted into their personal project within Mentaport’s Registry Contract.
  • Each user has their own project, where they are the sole owner with full control over all associated certificates.
  • If a user does not provide a wallet, Mentaport automatically generates one using their email and account abstraction.

Certificate Ownership & Minting​

All certificates created by a user are minted to their projects wallet. This structure guarantees that every creator maintains full control over their certificates while leveraging Mentaport’s secure and scalable registry.

How to Create a Watermarked Certificate​

  1. Upload Content and Metadata

    Submit your content along with relevant metadata for processing.

  2. Approve Watermarked Content

    Review and confirm the accuracy of the watermark and provided information.

  3. Mint Certificate

    Upon approval, the system automatically mints a unique certificate.

  4. Download Content

    Access and download the newly watermarked content, now securely linked to the certificate.

extension

Certificate Creation Process & Status Updates​

Our SDK is built to be asynchronous, ensuring efficient handling of large file uploads and managing the time required for watermarking. Here’s what to expect during the process:

  1. Initialization
    • When you create a certificate, the initial status will be Initialized.
  2. Status Checking
    • Periodically check the status of the certificate.
    • Once the status updates to Pending, you can proceed with approval.
  3. Approval & Finalization
    • After reaching Pending, you can approve the certificate to finalize the process.
  4. Handling Errors
    • If an issue occurs during watermarking, the status will change to Non Active.
    • An error message will be provided to help you identify and resolve the issue.

This process ensures a seamless and transparent workflow for certificate creation and watermark verification.

extension
API Key Security

For security purposes, we recommend using server-side applications. This way, your API Key will be highly protected.

SDK Update: Version 1.3.0-alpha.1

We are pleased to announce the release of SDK version 1.3.0-alpha.1.

Users are highly encouraged to upgrade to this version to utilize the enhanced features and improved functionality of the Certificate Project Admin SDK. This latest version is essential for managing projects efficiently and ensuring compatibility with our latest tools.

Important Upgrade Information:​

  • Current Certificate SDK Version: 1.3.0-alpha.1
  • Required for: Utilizing the Certificate Project Admin SDK to manage user projects.

Deprecated Version Notice:​

  • Older Certificate SDK Version: 1.2.0-alpha.1
  • Status: Active, but scheduled for deprecation.
  • Action Required: Users currently on version 1.2.0-alpha.1 should upgrade to 1.3.0-alpha.1 as soon as possible to continue receiving support and to access the full capabilities of the Certificate Project Admin SDK.

Breaking Changes in Version 1.3.0-alpha.1:​

Change in Identifier: The contractId parameter has been renamed to projectId. This change is critical for aligning with our new project management framework.

Upgrade Benefits:​

  • Access to new features and enhancements not available in previous versions.
  • Improved stability and performance optimizations.
  • Continued support and updates from our development team.

We appreciate your cooperation in updating to the latest version to take full advantage of the improvements we have made.